Interface FrameInstance

All Superinterfaces:
IPCObject
All Known Implementing Classes:
FrameInstanceImpl

public interface FrameInstance extends IPCObject
Information provided by the PKI file:

    \class FrameInstance
    
    \brief FrameInstance holds traffic details such as PDUs, ports, etc.
    
    \example appWindow().getActiveFile().getMainSimulation().getFrameInstanceAt(0)
    
Author:
Auto-generated
  • Method Details

    • getUserTrafficType

      TrafficType getUserTrafficType()
      Information provided by the PKI file:
      
          \brief Returns the user traffic type.
          
          \return TrafficType, the user traffic type.
          User traffic types:
          eTrafficType_Icmp           = 0,
          eTrafficType_Tcp            = 1,
          eTrafficType_Udp            = 2,
          eTrafficType_RipV1          = 3,
          eTrafficType_RipV2          = 4,
          eTrafficType_Arp            = 5,
          eTrafficType_Cdp            = 6,
          eTrafficType_Dhcp           = 7,
          eTrafficType_Nat            = 8,
          eTrafficType_Eigrp          = 9,
          eTrafficType_Vtp            = 10,
          eTrafficType_Stp            = 11,
          eTrafficType_Ospf           = 12,
          eTrafficType_Dtp            = 13,
          eTrafficType_Telnet         = 14,
          eTrafficType_Ssh            = 15,
          eTrafficType_Tftp           = 16,
          eTrafficType_Http           = 17,
          eTrafficType_Https          = 18,
          eTrafficType_Dns            = 19,
          eTrafficType_Icmpv6         = 20,
          eTrafficType_Lacp           = 21,
          eTrafficType_Pagp           = 22,
          eTrafficType_Ipsec          = 23,
          eTrafficType_Ike            = 24,
          eTrafficType_Syslog         = 25,
          eTrafficType_Tacacs         = 26,
          eTrafficType_Radius         = 27,
          eTrafficType_Snmp           = 28,
          eTrafficType_Ntp            = 29,
          eTrafficType_Ftp            = 30,
          eTrafficType_Smtp           = 31,
          eTrafficType_Pop3           = 32,
          eTrafficType_Sccp           = 33,
          eTrafficType_Rtp            = 34,
          eTrafficType_H323           = 35,
          eTrafficType_Bgp            = 36,
          eTrafficType_Hsrp           = 37,
          eTrafficType_Hsrpv6         = 38,
          eTrafficType_Netflow        = 39,
          eTrafficType_Ndv6           = 40,
          eTrafficType_Ripng          = 41,
          eTrafficType_Dhcpv6         = 42,
          eTrafficType_Eigrpv6        = 43,
          eTrafficType_Ospfv6         = 44,
          eTrafficType_IoE            = 45,
          eTrafficType_Ptp            = 46,
          eTrafficType_Rep            = 47,
          eTrafficType_CapwapUdp      = 48,
          eTrafficType_Lldp           = 49,
          eTrafficType_Span           = 50,
          eTrafficType_IoETcp         = 51,
          eTrafficType_Usb            = 52,
          eTrafficType_Bluetooth      = 53,
          eTrafficType_Custom         = 1000
          
              
      Returns:
      TrafficType Returns a TrafficType
    • getDestinationString

      String getDestinationString()
      Information provided by the PKI file:
      
          \brief Returns the destination.
          
          \return QString, the destination.
          
              
      Returns:
      String Returns a String
    • getSourceString

      String getSourceString()
      Information provided by the PKI file:
      
          \brief Returns the source.
          
          \return QString, the source.
          
              
      Returns:
      String Returns a String
    • getDevice

      Device getDevice()
      Information provided by the PKI file:
      
          \brief Returns the current device the frame instance is at.
          
          \return Device, the Device object the frame instance is at.
          
              
      Returns:
      Device Returns a Device
    • getPreviousDevice

      Device getPreviousDevice()
      Information provided by the PKI file:
      
          \brief Returns the previous device the frame instance was at.
          
          \return Device, the Device object the frame instance was at.
          
              
      Returns:
      Device Returns a Device
    • getInFrame

      Pdu getInFrame()
      Information provided by the PKI file:
      
          \brief Returns the inbound frame.
          
          \return Pdu, the inbound frame Pdu object.
          
              
      Returns:
      Pdu Returns a Pdu
    • getOutFrame

      Pdu getOutFrame()
      Information provided by the PKI file:
      
          \brief Returns the outbound frame.
          
          \return Pdu, the outbound frame Pdu object.
          
              
      Returns:
      Pdu Returns a Pdu
    • getInPort

      Port getInPort()
      Information provided by the PKI file:
      
          \brief Returns the inbound port.
          
          \return Port, the inbound Port object.
          
              
      Returns:
      Port Returns a Port
    • getOutPort

      Port getOutPort(int outPortIndex)
      Information provided by the PKI file:
      
          \brief returns the outbound port at the specified index.
          
          \param outPortIndex, the index of the outbound port of interest.
          
          \return Port, the outbound Port object at the specified index.
          
              
      Parameters:
      outPortIndex - Takes in a parameter of outPortIndex
      Returns:
      Port Returns a Port
    • getOutPortCount

      int getOutPortCount()
      Information provided by the PKI file:
      
          \brief Returns the number of outbound ports.
          
          \return int, the number of outbound ports.
          
              
      Returns:
      int Returns a int
    • addDecision

      void addDecision(String id, String description, boolean isOsiIn, int osiLayer)
      Information provided by the PKI file:
      
          \brief Adds a flowchart decision with the specified ID and description at the specified layer.
          
          \param id, the flowchart ID.
          \param description, the flowchart description.
          \param isOsiIn, true if inbound layer decision, false if outbound layer decision.
          \param osiLayer, the OSI layer.
          
              
      Parameters:
      id - Takes in a parameter of id
      description - Takes in a parameter of description
      isOsiIn - Takes in a parameter of isOsiIn
      osiLayer - Takes in a parameter of osiLayer
    • getFlowChartNodeAt

      FlowChartNode getFlowChartNodeAt(int nodeIndex)
      Information provided by the PKI file:
      
          \brief Returns the flowchart node at the specified index.
          
          \param nodeIndex, the index of the flowchart node of interest.
          
          \return FlowChartNode, the FlowChartNode object att he specified index.
          
              
      Parameters:
      nodeIndex - Takes in a parameter of nodeIndex
      Returns:
      FlowChartNode Returns a FlowChartNode
    • getFrameDecsionAt

      FrameDecision getFrameDecsionAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the frame decision at the specified index.
          
          \param index, the index of the frame decision of interest.
          
          \return FrameDecision, the FrameDecision at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      FrameDecision Returns a FrameDecision
    • getFlowChartNodeCount

      int getFlowChartNodeCount()
      Information provided by the PKI file:
      
          \brief Returns the number of flowchart nodes.
          
          \return int, the number of flowchart nodes.
          
              
      Returns:
      int Returns a int
    • getDecisionAt

      String getDecisionAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the decision at the specified index.
          
          \param index, the index of the decision of interest.
          
          \return QString, the decision at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String
    • setFrameSent

      void setFrameSent(boolean sent)
      Information provided by the PKI file:
      
          \brief Sets the frame as sent or unsent.
          
          \param sent, true for sent, false for unsent.
          
              
      Parameters:
      sent - Takes in a parameter of sent
    • isFrameSent

      boolean isFrameSent()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is sent, otherwise false.
          
          \return bool, true if the the frame is sent, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setFrameBuffered

      void setFrameBuffered(boolean buffered)
      Information provided by the PKI file:
      
          \brief Sets the frame as buffered or unbuffered.
          
          \param buffered, true for buffered, false for unbuffered.
          
              
      Parameters:
      buffered - Takes in a parameter of buffered
    • isFrameBuffered

      boolean isFrameBuffered()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is buffered, otherwise false.
          
          \return bool, true if the the frame is buffered, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setFrameDropped

      void setFrameDropped(boolean dropped)
      Information provided by the PKI file:
      
          \brief Sets the frame as dropped or not dropped.
          
          \param dropped, true for dropped, false for not dropped.
          
              
      Parameters:
      dropped - Takes in a parameter of dropped
    • isFrameDropped

      boolean isFrameDropped()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is dropped, otherwise false.
          
          \return bool, true if the the frame is dropped, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setFrameNotForwarded

      void setFrameNotForwarded(boolean notForwarded)
      Information provided by the PKI file:
      
          \brief Sets the frame as not forwarded or forwarded.
          
          \param notForwarded, true for not forwarded, false for forwarded.
          
              
      Parameters:
      notForwarded - Takes in a parameter of notForwarded
    • isFrameNotForwarded

      boolean isFrameNotForwarded()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is not forwarded, otherwise false.
          
          \return bool, true if the the frame is not forwarded, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setFrameAccepted

      void setFrameAccepted(boolean accepted)
      Information provided by the PKI file:
      
          \brief Sets the frame as accepted or not accepted.
          
          \param accepted, true for accepted, false for not accepted.
          
              
      Parameters:
      accepted - Takes in a parameter of accepted
    • isFrameAccepted

      boolean isFrameAccepted()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is accepted, otherwise false.
          
          \return bool, true if the the frame is accepted, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setFrameUnexpected

      void setFrameUnexpected(boolean unexpected)
      Information provided by the PKI file:
      
          \brief Sets the frame as unexpected or expected.
          
          \param unexpected, true for unexpected, false for expected.
          
              
      Parameters:
      unexpected - Takes in a parameter of unexpected
    • isFrameUnexpected

      boolean isFrameUnexpected()
      Information provided by the PKI file:
      
          \brief Returns true if the the frame is unexpected, otherwise false.
          
          \return bool, true if the the frame is unexpected, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isFrameCollidedOnLink

      boolean isFrameCollidedOnLink()
      Information provided by the PKI file:
      
          \brief Returns true if the frame collided on the link, otherwise false.
          
          \return bool, true if the frame collided on the link, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isFrameCollidedAtDevice

      boolean isFrameCollidedAtDevice()
      Information provided by the PKI file:
      
          \brief Returns true if the frame collided at the device, otherwise false.
          
          \return bool, true if the frame collided at the device, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isFrameOnTransit

      boolean isFrameOnTransit()
      Information provided by the PKI file:
      
          \brief Returns true if the frame is in transit, otherwise false.
          
          \return bool, true if the frame is in transit, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getQosStampColorCode

      int getQosStampColorCode()
      Information provided by the PKI file:
      
          \brief Returns the QoS stamp color code.
          
          \return int, the QoS stamp color code.
          
              
      Returns:
      int Returns a int
    • getInQosStampColorCode

      int getInQosStampColorCode()
      Information provided by the PKI file:
      
          \brief Returns the inbound QoS stamp color code.
          
          \return int, the inbound QoS stamp color code.
          
              
      Returns:
      int Returns a int
    • getOutQosStampColorCode

      int getOutQosStampColorCode()
      Information provided by the PKI file:
      
          \brief Returns the outbound QoS stamp color code.
          
          \return int, the outbound QoS stamp color code.
          
              
      Returns:
      int Returns a int
    • getTransitTime

      int getTransitTime()
      Information provided by the PKI file:
      
          \brief Returns the transit time.
          
          \return int, the transit time.
          
              
      Returns:
      int Returns a int
    • getPercentageSent

      int getPercentageSent()
      Information provided by the PKI file:
      
          \brief Returns the percentage of the frame that was sent.
          
          \return int, the percentage of the frame that was sent.
          
              
      Returns:
      int Returns a int
    • getStartSimTime

      long getStartSimTime()
      Information provided by the PKI file:
      
          \brief Returns the simulation start time.
          
          \return int, the simulation start time.
          
              
      Returns:
      long Returns a long
    • getTrafficSource

      UserTraffic getTrafficSource()
      Information provided by the PKI file:
      
          \brief Returns the traffic source.
          
          \return UserTraffic, the soure UserTraffic object.
          
              
      Returns:
      UserTraffic Returns a UserTraffic
    • getTime

      int getTime()
      Information provided by the PKI file:
      
          \brief Returns time of the frame instance.
          
          \return int, time of the frame instance.
          
              
      Returns:
      int Returns a int